<!DOCTYPE HTML>
<html lang="">
<head>
  <meta charset="UTF-8">
  <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  <title>Labelling · GitBook</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
  <meta name="description" content="">
  <meta name="generator" content="GitBook 3.2.2">
  <meta name="author" content="chartjs">


  <link rel="stylesheet" href="../gitbook/style.css">


  <link rel="stylesheet" href="../gitbook/gitbook-plugin-search-plus/search.css">


  <link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">


  <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">


  <link rel="stylesheet" href="../style.css">


  <meta name="HandheldFriendly" content="true"/>
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="apple-mobile-web-app-capable" content="yes">
  <meta name="apple-mobile-web-app-status-bar-style" content="black">
  <link rel="apple-touch-icon-precomposed" sizes="152x152"
        href="../gitbook/images/apple-touch-icon-precomposed-152.png">
  <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">


  <link rel="next" href="styling.html"/>


  <link rel="prev" href="radial/linear.html"/>


  <link rel="stylesheet" href="../gitbook/gitbook-plugin-chartjs/style.css">
  <script src="../gitbook/gitbook-plugin-chartjs/Chart.bundle.js"></script>
  <script src="../gitbook/gitbook-plugin-chartjs/chartjs-plugin-deferred.js"></script>


</head>
<body>

<div class="book">
  <div class="book-summary">


    <div id="book-search-input" role="search">
      <input type="text" placeholder="Type to search"/>
    </div>


    <nav role="navigation">


      <ul class="summary">


        <li class="chapter " data-level="1.1" data-path="../">

          <a href="../">


            Chart.js

          </a>


        </li>

        <li class="chapter " data-level="1.2" data-path="../getting-started/">

          <a href="../getting-started/">


            Getting Started

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.2.1" data-path="../getting-started/installation.html">

              <a href="../getting-started/installation.html">


                Installation

              </a>


            </li>

            <li class="chapter " data-level="1.2.2" data-path="../getting-started/integration.html">

              <a href="../getting-started/integration.html">


                Integration

              </a>


            </li>

            <li class="chapter " data-level="1.2.3" data-path="../getting-started/usage.html">

              <a href="../getting-started/usage.html">


                Usage

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.3" data-path="../general/">

          <a href="../general/">


            General

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.3.1" data-path="../general/responsive.html">

              <a href="../general/responsive.html">


                Responsive

              </a>


            </li>

            <li class="chapter " data-level="1.3.2" data-path="../general/interactions/">

              <a href="../general/interactions/">


                Interactions

              </a>


              <ul class="articles">


                <li class="chapter " data-level="1.3.2.1" data-path="../general/interactions/events.html">

                  <a href="../general/interactions/events.html">


                    Events

                  </a>


                </li>

                <li class="chapter " data-level="1.3.2.2" data-path="../general/interactions/modes.html">

                  <a href="../general/interactions/modes.html">


                    Modes

                  </a>


                </li>


              </ul>

            </li>

            <li class="chapter " data-level="1.3.3" data-path="../general/options.html">

              <a href="../general/options.html">


                Options

              </a>


            </li>

            <li class="chapter " data-level="1.3.4" data-path="../general/colors.html">

              <a href="../general/colors.html">


                Colors

              </a>


            </li>

            <li class="chapter " data-level="1.3.5" data-path="../general/fonts.html">

              <a href="../general/fonts.html">


                Fonts

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.4" data-path="../configuration/">

          <a href="../configuration/">


            Configuration

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.4.1" data-path="../configuration/animations.html">

              <a href="../configuration/animations.html">


                Animations

              </a>


            </li>

            <li class="chapter " data-level="1.4.2" data-path="../configuration/layout.html">

              <a href="../configuration/layout.html">


                Layout

              </a>


            </li>

            <li class="chapter " data-level="1.4.3" data-path="../configuration/legend.html">

              <a href="../configuration/legend.html">


                Legend

              </a>


            </li>

            <li class="chapter " data-level="1.4.4" data-path="../configuration/title.html">

              <a href="../configuration/title.html">


                Title

              </a>


            </li>

            <li class="chapter " data-level="1.4.5" data-path="../configuration/tooltip.html">

              <a href="../configuration/tooltip.html">


                Tooltip

              </a>


            </li>

            <li class="chapter " data-level="1.4.6" data-path="../configuration/elements.html">

              <a href="../configuration/elements.html">


                Elements

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.5" data-path="../charts/">

          <a href="../charts/">


            Charts

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.5.1" data-path="../charts/line.html">

              <a href="../charts/line.html">


                Line

              </a>


            </li>

            <li class="chapter " data-level="1.5.2" data-path="../charts/bar.html">

              <a href="../charts/bar.html">


                Bar

              </a>


            </li>

            <li class="chapter " data-level="1.5.3" data-path="../charts/radar.html">

              <a href="../charts/radar.html">


                Radar

              </a>


            </li>

            <li class="chapter " data-level="1.5.4" data-path="../charts/doughnut.html">

              <a href="../charts/doughnut.html">


                Doughnut & Pie

              </a>


            </li>

            <li class="chapter " data-level="1.5.5" data-path="../charts/polar.html">

              <a href="../charts/polar.html">


                Polar Area

              </a>


            </li>

            <li class="chapter " data-level="1.5.6" data-path="../charts/bubble.html">

              <a href="../charts/bubble.html">


                Bubble

              </a>


            </li>

            <li class="chapter " data-level="1.5.7" data-path="../charts/scatter.html">

              <a href="../charts/scatter.html">


                Scatter

              </a>


            </li>

            <li class="chapter " data-level="1.5.8" data-path="../charts/area.html">

              <a href="../charts/area.html">


                Area

              </a>


            </li>

            <li class="chapter " data-level="1.5.9" data-path="../charts/mixed.html">

              <a href="../charts/mixed.html">


                Mixed

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.6" data-path="./">

          <a href="./">


            Axes

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.6.1" data-path="cartesian/">

              <a href="cartesian/">


                Cartesian

              </a>


              <ul class="articles">


                <li class="chapter " data-level="1.6.1.1" data-path="cartesian/category.html">

                  <a href="cartesian/category.html">


                    Category

                  </a>


                </li>

                <li class="chapter " data-level="1.6.1.2" data-path="cartesian/linear.html">

                  <a href="cartesian/linear.html">


                    Linear

                  </a>


                </li>

                <li class="chapter " data-level="1.6.1.3" data-path="cartesian/logarithmic.html">

                  <a href="cartesian/logarithmic.html">


                    Logarithmic

                  </a>


                </li>

                <li class="chapter " data-level="1.6.1.4" data-path="cartesian/time.html">

                  <a href="cartesian/time.html">


                    Time

                  </a>


                </li>


              </ul>

            </li>

            <li class="chapter " data-level="1.6.2" data-path="radial/">

              <a href="radial/">


                Radial

              </a>


              <ul class="articles">


                <li class="chapter " data-level="1.6.2.1" data-path="radial/linear.html">

                  <a href="radial/linear.html">


                    Linear

                  </a>


                </li>


              </ul>

            </li>

            <li class="chapter active" data-level="1.6.3" data-path="labelling.html">

              <a href="labelling.html">


                Labelling

              </a>


            </li>

            <li class="chapter " data-level="1.6.4" data-path="styling.html">

              <a href="styling.html">


                Styling

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.7" data-path="../developers/">

          <a href="../developers/">


            Developers

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.7.1" data-path="../developers/api.html">

              <a href="../developers/api.html">


                Chart.js API

              </a>


            </li>

            <li class="chapter " data-level="1.7.2" data-path="../developers/updates.html">

              <a href="../developers/updates.html">


                Updating Charts

              </a>


            </li>

            <li class="chapter " data-level="1.7.3" data-path="../developers/plugins.html">

              <a href="../developers/plugins.html">


                Plugins

              </a>


            </li>

            <li class="chapter " data-level="1.7.4" data-path="../developers/charts.html">

              <a href="../developers/charts.html">


                New Charts

              </a>


            </li>

            <li class="chapter " data-level="1.7.5" data-path="../developers/axes.html">

              <a href="../developers/axes.html">


                New Axes

              </a>


            </li>

            <li class="chapter " data-level="1.7.6" data-path="../developers/contributing.html">

              <a href="../developers/contributing.html">


                Contributing

              </a>


            </li>


          </ul>

        </li>

        <li class="chapter " data-level="1.8" data-path="../notes/">

          <a href="../notes/">


            Additional Notes

          </a>


          <ul class="articles">


            <li class="chapter " data-level="1.8.1" data-path="../notes/comparison.html">

              <a href="../notes/comparison.html">


                Comparison Table

              </a>


            </li>

            <li class="chapter " data-level="1.8.2" data-path="../notes/extensions.html">

              <a href="../notes/extensions.html">


                Popular Extensions

              </a>


            </li>

            <li class="chapter " data-level="1.8.3" data-path="../notes/license.html">

              <a href="../notes/license.html">


                License

              </a>


            </li>


          </ul>

        </li>


        <li class="divider"></li>

        <li>
          <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
          </a>
        </li>
      </ul>


    </nav>


  </div>

  <div class="book-body">

    <div class="body-inner">


      <div class="book-header" role="navigation">


        <!-- Title -->
        <h1>
          <i class="fa fa-circle-o-notch fa-spin"></i>
          <a href="..">Labelling</a>
        </h1>
      </div>


      <div class="page-wrapper" tabindex="-1" role="main">
        <div class="page-inner">

          <div class="search-plus" id="book-search-results">
            <div class="search-noresults">

              <section class="normal markdown-section">

                <h1 id="labeling-axes">Labeling Axes</h1>
                <p>When creating a chart, you want to tell the viewer what data they are viewing. To do this, you need
                  to label the axis.</p>
                <h2 id="scale-title-configuration">Scale Title Configuration</h2>
                <p>The scale label configuration is nested under the scale configuration in the <code>scaleLabel</code>
                  key. It defines options for the scale title. Note that this only applies to cartesian axes.</p>
                <table>
                  <thead>
                  <tr>
                    <th>Name</th>
                    <th>Type</th>
                    <th>Default</th>
                    <th>Description</th>
                  </tr>
                  </thead>
                  <tbody>
                  <tr>
                    <td><code>display</code></td>
                    <td><code>Boolean</code></td>
                    <td><code>false</code></td>
                    <td>If true, display the axis title.</td>
                  </tr>
                  <tr>
                    <td><code>labelString</code></td>
                    <td><code>String</code></td>
                    <td><code>&apos;&apos;</code></td>
                    <td>The text for the title. (i.e. &quot;# of People&quot; or &quot;Response Choices&quot;).</td>
                  </tr>
                  <tr>
                    <td><code>lineHeight</code></td>
                    <td><code>Number/String</code></td>
                    <td><code>1.2</code></td>
                    <td>Height of an individual line of text (see <a
                        href="https://developer.mozilla.org/en-US/docs/Web/CSS/line-height" target="_blank">MDN</a>)
                    </td>
                  </tr>
                  <tr>
                    <td><code>fontColor</code></td>
                    <td><code>Color</code></td>
                    <td><code>&apos;#666&apos;</code></td>
                    <td>Font color for scale title.</td>
                  </tr>
                  <tr>
                    <td><code>fontFamily</code></td>
                    <td><code>String</code></td>
                    <td><code>&quot;&apos;Helvetica Neue&apos;, &apos;Helvetica&apos;, &apos;Arial&apos;, sans-serif&quot;</code>
                    </td>
                    <td>Font family for the scale title, follows CSS font-family options.</td>
                  </tr>
                  <tr>
                    <td><code>fontSize</code></td>
                    <td><code>Number</code></td>
                    <td><code>12</code></td>
                    <td>Font size for scale title.</td>
                  </tr>
                  <tr>
                    <td><code>fontStyle</code></td>
                    <td><code>String</code></td>
                    <td><code>&apos;normal&apos;</code></td>
                    <td>Font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique,
                      initial, inherit).
                    </td>
                  </tr>
                  <tr>
                    <td><code>padding</code></td>
                    <td><code>Number/Object</code></td>
                    <td><code>4</code></td>
                    <td>Padding to apply around scale labels. Only <code>top</code> and <code>bottom</code> are
                      implemented.
                    </td>
                  </tr>
                  </tbody>
                </table>
                <h2 id="creating-custom-tick-formats">Creating Custom Tick Formats</h2>
                <p>It is also common to want to change the tick marks to include information about the data type. For
                  example, adding a dollar sign (&apos;$&apos;). To do this, you need to override the <code>ticks.callback</code>
                  method in the axis configuration.
                  In the following example, every label of the Y axis would be displayed with a dollar sign at the
                  front..</p>
                <p>If the callback returns <code>null</code> or <code>undefined</code> the associated grid line will be
                  hidden.</p>
                <pre><code class="lang-javascript"><span class="hljs-keyword">var</span> chart = <span
                    class="hljs-keyword">new</span> Chart(ctx, {
    type: <span class="hljs-string">&apos;line&apos;</span>,
    data: data,
    options: {
        scales: {
            yAxes: [{
                ticks: {
                    <span class="hljs-comment">// Include a dollar sign in the ticks</span>
                    callback: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span
                      class="hljs-params">value, index, values</span>) </span>{
                        <span class="hljs-keyword">return</span> <span class="hljs-string">&apos;$&apos;</span> + value;
                    }
                }
            }]
        }
    }
});
</code></pre>


              </section>

            </div>
            <div class="search-results">
              <div class="has-results">

                <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span
                    class='search-query'></span>"</h1>
                <ul class="search-results-list"></ul>

              </div>
              <div class="no-results">

                <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>

              </div>
            </div>
          </div>

        </div>
      </div>

    </div>


    <a href="radial/linear.html" class="navigation navigation-prev " aria-label="Previous page: Linear">
      <i class="fa fa-angle-left"></i>
    </a>


    <a href="styling.html" class="navigation navigation-next " aria-label="Next page: Styling">
      <i class="fa fa-angle-right"></i>
    </a>


  </div>

  <script>
    var gitbook = gitbook || [];
    gitbook.push(function () {
      gitbook.page.hasChanged({
        "page": {
          "title": "Labelling",
          "level": "1.6.3",
          "depth": 2,
          "next": {
            "title": "Styling",
            "level": "1.6.4",
            "depth": 2,
            "path": "axes/styling.md",
            "ref": "axes/styling.md",
            "articles": []
          },
          "previous": {
            "title": "Linear",
            "level": "1.6.2.1",
            "depth": 3,
            "path": "axes/radial/linear.md",
            "ref": "axes/radial/linear.md",
            "articles": []
          },
          "dir": "ltr"
        },
        "config": {
          "plugins": ["-lunr", "-search", "search-plus", "anchorjs", "chartjs", "ga"],
          "root": "./docs",
          "styles": {
            "website": "style.css",
            "pdf": "styles/pdf.css",
            "epub": "styles/epub.css",
            "mobi": "styles/mobi.css",
            "ebook": "styles/ebook.css",
            "print": "styles/print.css"
          },
          "pluginsConfig": {
            "anchorjs": {"icon": "#", "placement": "left", "visible": "always"},
            "ga": {"configuration": "auto", "token": "UA-28909194-3"},
            "theme-default": {
              "styles": {
                "website": "style.css",
                "pdf": "styles/pdf.css",
                "epub": "styles/epub.css",
                "mobi": "styles/mobi.css",
                "ebook": "styles/ebook.css",
                "print": "styles/print.css"
              }, "showLevel": false
            },
            "search-plus": {},
            "chartjs": {"defaults": null},
            "highlight": {},
            "sharing": {
              "facebook": true,
              "twitter": true,
              "google": false,
              "weibo": false,
              "instapaper": false,
              "vk": false,
              "all": ["facebook", "google", "twitter", "weibo", "instapaper"]
            },
            "fontsettings": {"theme": "white", "family": "sans", "size": 2}
          },
          "theme": "default",
          "author": "chartjs",
          "pdf": {
            "pageNumbers": true,
            "fontSize": 12,
            "fontFamily": "Arial",
            "paperSize": "a4",
            "chapterMark": "pagebreak",
            "pageBreaksBefore": "/",
            "margin": {"right": 62, "left": 62, "top": 56, "bottom": 56}
          },
          "structure": {"langs": "LANGS.md", "readme": "README.md", "glossary": "GLOSSARY.md", "summary": "SUMMARY.md"},
          "variables": {},
          "gitbook": "3.2.2"
        },
        "file": {"path": "axes/labelling.md", "mtime": "2017-10-28T15:03:49.266Z", "type": "markdown"},
        "gitbook": {"version": "3.2.2", "time": "2017-10-28T15:09:53.587Z"},
        "basePath": "..",
        "book": {"language": ""}
      });
    });
  </script>
</div>


<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>


<script src="../gitbook/gitbook-plugin-search-plus/jquery.mark.min.js"></script>


<script src="../gitbook/gitbook-plugin-search-plus/search.js"></script>


<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.1.1/anchor.min.js"></script>


<script src="../gitbook/gitbook-plugin-anchorjs/anchor-style.js"></script>


<script src="../gitbook/gitbook-plugin-ga/plugin.js"></script>


<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>


<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>


</body>
</html>

